/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.client.serializer;

import java.io.InputStream;
import java.io.OutputStream;

import jp.fores.midori.core.dto.RPCInputDto;

/**
 * リモートプロシージャーコールの各種形式に応じたシリアライズ・デシリアライズ処理を行うインターフェース。<br>
 */
public interface RPCSerializer {
	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//抽象メソッド

	/**
	 * Content-Typeを取得します。<br>
	 *
	 * @return Content-Type
	 */
	public String getContentType();

	/**
	 * RPCの入力データを格納するためのDTOクラスの内容を、出力ストリームに出力します。<br>
	 *
	 * @param inputDto RPCの入力データを格納するためのDTOクラスのインスタンス
	 * @param os 出力ストリーム
	 * @throws Exception 例外
	 */
	public void inputDtoToOutputStream(RPCInputDto inputDto, OutputStream os)
			throws Exception;

	/**
	 * レスポンスの入力ストリームを処理して、リモートプロシージャコールの戻り値を取得します。<br>
	 * レスポンスのエラーチェックもこのメソッドで行います。<br>
	 *
	 * @param is 入力ストリーム
	 * @return リモートプロシージャコールの戻り値のオブジェクト(戻り値が存在しない場合はnull)
	 * @throws Exception 例外
	 */
	public Object handleRPCResponseInputStream(InputStream is) throws Exception;

}
